Create a new series

POST /series

POST /content/v1/series/

This call allows you to create or update a series.

The contentId is the unique identifier which needs to be used for further interaction with this specific series via the API. Internally, the contentId is mapped to the External reference field on the series.

The contentId is not specified in the URL, instead it can be specified in the body of the call. WHATS’ON checks if the contentId exists and if so, it updates the series with that contentId (i.e. external reference). If it doesn't exist, a new series will be created. The contentId will be returned as part of the response.

POST /series/

{
    "contentId": "SR1234",
    "title": "The Office (US)",
    "duration": "00:22:00",
    ...
}

If no contentId is part of the body a unique contentId will be generated for the newly created series and returned as part of the response.

If the template is specified in the URL, the series will be created from a product prototype created in WHATS'ON.

The available fields are specified in the provided Swagger file.

All the drop-down lists in the call are mapped using the API reference property on the drop-down value. See the Drop-downs page for more information.

If WHATS'ON is configured to automatically calculate the product code, the product code in the body of the call is ignored and the logic is applied. If the episode is being updated and the product code in WHATS'ON is read-only, the product code in the body will be ignored.

Request

Following fields can be specified in the URL:

  • template (optional) This parameter can be used to create a series with a template. This parameter matches to the API reference field on the product prototype in WHATS'ON

To create a series, following fields are required in the body:

  • title
  • duration

To update an episode, following fields are required in the body:

  • contentId

You can find more information about the body structure and fields in the provided Swagger file.